PBDeleteFileIDRefSync

PBDeleteFileIDRef Delete a file ID reference

#include <Files.h> File Manager

HParmBlkPtr pb ; pointer to a file ID parameter block

Boolean async ; 0=await completion; 1=immediate return

returns Error Code; 0=no error

Use the PBDeleteFileIDRef function to delete a file ID reference.

pb is a pointer to a FIDParam structure.The relevant fields are as

follows:

Æ ioCompletion ProcPtr 4 12 pointer to completion routine

¨ ioResult short 2 16 result code

Æ ioNamePtr StringPtr 4 18 pointer to first filename

Æ ioVRefNum short 2 22 volume specification (volume reference number,

working directory reference number, drive

number, or 0 for default volume)

€Æ ioFileID long 4 54 file ID

async is a Boolean value. Use FALSE for normal (synchronous) operation

or TRUE to enqueue the request and resume control immediately. See

Async I/O.

Returns: an operating system Error Code. It will be one of:

noErr (0) No error

nsvErr (-35) Volume not found

ioErr (-36) I/O error

wPrErr (-44) Hardware volume lock

vLckdErr (-46) Software volume lock

volOfflinErr (-53) Volume is off line

extFSErr (-58) External file system

fidNotFoundErr (-1300) File ID not found

Notes: PBDeleteFileIDRef invalidates the specified file ID on the volume

specified by ioVRefNum or ioNamePtr. After it has invalidated a file ID, the

File Manager can no longer resolve that ID to a filename and parent

directory ID.

Referenced by (3):